Skip to content

Load comments and users in chunks in wp comment list and wp user list - #666

Open
swissspidy wants to merge 3 commits into
claude/post-list-chunkedfrom
claude/list-chunked
Open

swissspidy wants to merge 3 commits into
claude/post-list-chunkedfrom
claude/list-chunked

Conversation

@swissspidy

@swissspidy swissspidy commented Oct 6, 2026 •

Copy link
Copy Markdown
Member

Stacked on #663. It applies the same approach as wp post list to comments and users. Please merge #663 first; this PR's base will then switch to main.

Changes

  • Chunked loading: wp comment list and wp user list query the IDs of all matching items first, then load the objects a chunk at a time and clear the object cache after each chunk. Together with the formatter streaming iterators (Stream CSV and JSON output when items are given as an iterator wp-cli#6420 and follow-ups), memory no longer grows with the number of items.
  • Fields read through the cache: user meta and a comment's post fields (like post_title) are read while each item is current (Only keep the requested fields of items from an iterator wp-cli#6426), so the cache can always be cleared. The posts of each chunk of comments are loaded in one query, so a post isn't loaded again for each of its comments.
  • url only when displayed: the url field of comments, users and terms is now only computed when it's requested. For comments it was about 40% of the time.
  • Shared helpers: the chunk size and the cache helper move from Post_Command to CommandWithDBObject.

--format=ids and --format=count keep their existing path.

Results

--format=csv Before After
wp comment list, 100k comments 630 MB ~110 MB
wp user list, 50k users 790 MB ~140 MB

Run time drops by about 40% for both. The output is identical to main.

With WP-CLI main, on the same site:

--format=csv Time Memory
wp user list --fields=ID,user_login,first_name,nickname 4.0 s 107 MB
wp comment list --fields=comment_ID,post_title 2.9 s 138 MB

Tests

  • New scenarios in features/comment.feature and features/user.feature. Each lists more items than one chunk (1,200 comments, 600 users) and checks:
    • the order matches --format=ids,
    • the CSV row count,
    • the url field for comments, and a user meta field for users.
  • Feature suites: comment.feature, user.feature, term.feature and post.feature pass locally (92 scenarios) with WP-CLI main.
  • Static checks: PHPCS is clean, and PHPStan reports no new errors.

🤖 Generated with Claude Code

https://claude.ai/code/session_01D26yjkN2BiqCXT6p6o1WqS

Summary by CodeRabbit

  • Improvements
    • Comment and user listings now process large result sets in batches, helping maintain reliable output for extensive lists.
    • Large comment and user lists preserve expected ordering and values in ID and CSV output.
    • Comment, user, and term URLs are included when requested by the selected output fields.

…ist`

Like `wp post list`, query the IDs of all matching comments or users
first, then load the objects a chunk at a time and clear the object
cache after each chunk. Combined with the formatter streaming CSV and
JSON output for iterators, the memory use no longer grows with the
number of items. If a displayed field is read through the object cache,
like user meta or the post title of a comment, the cache is kept.

Also only compute the `url` field of comments, users and terms when it
is displayed. For comments it took about 40% of the time.

The chunk size and the cache helper move to CommandWithDBObject.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D26yjkN2BiqCXT6p6o1WqS
Copilot AI balanced review requested due to automatic review settings October 6, 2026 16:28
@swissspidy
swissspidy requested a review from a team as a code owner October 6, 2026 16:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2d6ae73e-7c86-427d-b924-5f0c5e9fdc30
📥 Commits

Reviewing files that changed from the base of the PR and between 5bd5d04 and ae6bbcf.

📒 Files selected for processing (5)
  • src/Comment_Command.php
  • src/Post_Command.php
  • src/Term_Command.php
  • src/User_Command.php
  • src/WP_CLI/CommandWithDBObject.php
💤 Files with no reviewable changes (1)
  • src/Post_Command.php

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Comment and user listings now load eligible results in chunks and preserve query order. Comment, user, and term listings add URLs only when requested. Feature scenarios check large comment and user listings and CSV output.

Changes

Entity listing updates

Layer / File(s) Summary
Shared chunk and cache support
src/WP_CLI/CommandWithDBObject.php, src/Post_Command.php
CommandWithDBObject defines a chunk size of 500 and a runtime cache-clearing helper. Post_Command removes its previous chunk-size constant and cache helper. query_posts_in_chunks() still calls the removed helper.
Chunked comment listing
src/Comment_Command.php, features/comment.feature
Non-hierarchical comment listings other than count and ids load results in chunks and preserve ID order. Comment URLs are added only when requested. The feature scenario checks large listings and CSV output.
Chunked user listing
src/User_Command.php, features/user.feature
User listings other than count and ids load results in chunks and preserve ID order. Roles are formatted as comma-separated strings, and URLs are added only when requested. The feature scenario checks large listings and CSV output.
Conditional term URLs
src/Term_Command.php
Term listing adds URLs only when the requested output fields include url.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Refactor

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant Comment_Command
  participant Database
  participant Formatter
  participant RuntimeCache
  CLI->>Comment_Command: request comment listing
  Comment_Command->>Database: query matching comment IDs
  Comment_Command->>Database: load comment batches
  Comment_Command->>Formatter: yield comments in ID order
  Comment_Command->>RuntimeCache: clear runtime cache after each batch
Loading
sequenceDiagram
  participant CLI
  participant User_Command
  participant Database
  participant Formatter
  participant RuntimeCache
  CLI->>User_Command: request user listing
  User_Command->>Database: query matching user IDs
  User_Command->>Database: load user batches
  User_Command->>Formatter: yield users in ID order
  User_Command->>RuntimeCache: clear runtime cache after each batch
Loading

Merge Risk: ⚪ Minimal · up to ae6bb

The change loads comments and users in chunks and computes URLs only when requested. No concrete merge-blocking risk is evident from the supplied context. The memory savings depend on companion changes in wp-cli core.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 4 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: loading comments and users in chunks for their list commands.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added command:comment-list Related to 'comment list' command command:user-list Related to 'user list' command labels Oct 6, 2026
@swissspidy
swissspidy added this pull request to stack #667 October 6, 2026 16:45
@codecov

codecov Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 92.85714% with 5 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/Comment_Command.php 94.73% 2 Missing ⚠️
src/WP_CLI/CommandWithDBObject.php 60.00% 2 Missing ⚠️
src/User_Command.php 95.83% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

claude added 2 commits October 7, 2026 14:25
wp-cli/wp-cli#6426 makes the formatter read the requested fields of each
item while it is current, also when it can't stream them. User meta and
the post fields of comments are therefore read before the cache of their
chunk is cleared, so the cache no longer needs to be kept for them.

The posts of each chunk of comments are now loaded in one query, so that
fields like post_title don't load each post again in every chunk.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D26yjkN2BiqCXT6p6o1WqS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

command:comment-list Related to 'comment list' command command:user-list Related to 'user list' command

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants